<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
    <title>ShellCheck: SC1127 – Was this intended as a comment? Use `#` in sh.</title>
    <link rel="stylesheet" href="css/bootstrap.min.css" />
  </head>
  <body style="margin-left: auto; margin-right: auto; max-width: 800px">
    <h1>SC1127 – ShellCheck Wiki</h1>
    <a href="https://github.com/koalaman/shellcheck/wiki/SC1127">See this page on GitHub</a>
    <p style="display: none"><a href="index.html">Sitemap</a></p>
    <hr />
    <h2 id="was-this-intended-as-a-comment-use--in-sh">Was this intended as
a comment? Use <code>#</code> in sh.</h2>
<h3 id="problematic-code">Problematic code:</h3>
<div class="sourceCode" id="cb1"><pre class="sourceCode c"><code class="sourceCode c"><span id="cb1-1"><a href="SC1127.html#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co">// This is a comment.</span></span>
<span id="cb1-2"><a href="SC1127.html#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="co">/* This too. */</span></span></code></pre></div>
<h3 id="correct-code">Correct code:</h3>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="SC1127.html#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># This is a comment.</span></span>
<span id="cb2-2"><a href="SC1127.html#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="co"># This too.</span></span></code></pre></div>
<h3 id="rationale">Rationale:</h3>
<p>ShellCheck found what appears to be a C-style comment, a line
starting with <code>//</code> or <code>/*</code>.</p>
<p>In Bourne based shell scripts, the comment character is
<code>#</code></p>
<h3 id="exceptions">Exceptions:</h3>
<p>None.</p>
    <hr />
    <p style='font-size: 80%'><a href="../index.html">ShellCheck</a> is a static analysis tool for shell scripts. This page is part of its documentation.</p>
  </body>
</html>


